ApiRange

Represents the ApiRange class.

Properties

Name	Type	Description
Row	number	Returns the row number for the selected cell.
Col	number	Returns the column number for the selected cell.
Rows	ApiRange	Returns the ApiRange object that represents the rows of the specified range.
Cols	ApiRange	Returns the ApiRange object that represents the columns of the specified range.
Cells	ApiRange	Returns a Range object that represents all the cells in the specified range or a specified cell.
Count	number	Returns the rows or columns count.
Address	string	Returns the range address.
Value	string	Returns a value from the first cell of the specified range or sets it to this cell.
Formula	string	Returns a formula from the first cell of the specified range or sets it to this cell.
Value2	string	Returns the value2 (value without format) from the first cell of the specified range or sets it to this cell.
Text	string	Returns the text from the first cell of the specified range or sets it to this cell.
FontColor	ApiColor	Sets the text color to the current cell range with the previously created color object.
Hidden	boolean	Returns or sets the value hiding property.
ColumnWidth	number	Returns or sets the width of all the columns in the specified range measured in points.
Width	number	Returns a value that represents the range width measured in points.
RowHeight	number	Returns or sets the height of the first row in the specified range measured in points.
Height	number	Returns a value that represents the range height measured in points.
FontSize	number	Sets the font size to the characters of the current cell range.
FontName	string	Sets the specified font family as the font name for the current cell range.
AlignVertical	'center'	'bottom'
AlignHorizontal	'left'	'right'
Bold	boolean	Sets the bold property to the text characters from the current cell or cell range.
Italic	boolean	Sets the italic property to the text characters in the current cell or cell range.
Underline	'none'	'single'
Strikeout	boolean	Sets a value that indicates whether the contents of the current cell or cell range are displayed struck through.
WrapText	boolean	Returns the information about the wrapping cell style or specifies whether the words in the cell must be wrapped to fit the cell size or not.
FillColor	ApiColor	'No Fill'
NumberFormat	string	Sets a value that represents the format code for the object.
MergeArea	ApiRange	Returns the cell or cell range from the merge area.
Worksheet	ApiWorksheet	Returns the ApiWorksheet object that represents the worksheet containing the specified range.
DefName	ApiName	Returns the ApiName object.
Comments	ApiComment	null
Orientation	'xlDownward'	'xlHorizontal'
Areas	ApiAreas	Returns a collection of the areas.
Characters	ApiCharacters	Returns the ApiCharacters object that represents a range of characters within the object text. Use the ApiCharacters object to format characters within a text string.
PivotTable	ApiPivotTable	null

Methods

• GetClassType
• GetRow
• GetCol
• Clear
• GetRows
• GetCols
• End
• GetCells
• SetOffset
• GetAddress
• GetCount
• GetValue
• SetValue
• GetFormula
• GetValue2
• GetText
• SetFontColor
• GetHidden
• SetHidden
• GetColumnWidth
• SetColumnWidth
• GetRowHeight
• SetRowHeight
• SetFontSize
• SetFontName
• SetAlignVertical
• SetAlignHorizontal
• SetBold
• SetItalic
• SetUnderline
• SetStrikeout
• SetWrap
• GetWrapText
• SetFillColor
• GetFillColor
• GetNumberFormat
• SetNumberFormat
• SetBorders
• Merge
• UnMerge
• ForEach
• AddComment
• GetWorksheet
• GetDefName
• GetComment
• Select
• GetOrientation
• SetOrientation
• SetSort
• Delete
• Insert
• AutoFit
• GetAreas
• Copy
• Cut
• Paste
• PasteSpecial
• GetPivotTable
• Find
• FindNext
• FindPrevious
• Replace
• GetCharacters
• SetAutoFilter